ποΈGitΠ―ΡΠ°ποΈ
README.md renovate/coil (9858429e) Text, 14.69 KB
<p align="center">
<img src=".github/meshtastic_logo.png" alt="Meshtastic Logo" width="200"/>
</p>
<h1 align="center">Meshtastic-Android</h1>
The Meshtastic client for Android and Compose Desktop β an app for communicating over open-source mesh radios. For more information see our webpage: meshtastic.org. The device-side code lives in the firmware repository.
If you have questions or feedback please Join our discussion forum or the Discord Group. We would love to hear from you!
Features
Highlights of the 2.8 line:
β’ Mesh network discovery to surface nodes and channels around you, with Mesh Beacon invitations for joining nearby meshes.
β’ Waypoint geofences β draw zones on the map and get alerts when nodes cross them.
β’ Secure key backup β encrypted backup, restore, and delete for your device security keys.
β’ NFC sharing β write shared contacts and channels to NFC tags.
β’ XEdDSA packet signing indicators in the node and messaging UI.
β’ Air-quality telemetry β PM1.0, PM2.5, PM10, and COβ readings from supported sensors.
β’ App Functions / system-AI integration so on-device assistants can trigger common workflows.
Get Meshtastic
The fastest way to get releases is GitHub releases; pair them with Obtainium for automatic updates.
With Obtainium installed, tap a link below on your phone to set it up with everything pre-configured. The T383838google flavor adds Google Crashlytics and Google Maps; T383838fdroid has no Google dependencies.
<!-- BEGIN GENERATED LINKS: obtainium/generate-links.py -->
ββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ¬ββββββ
β Channel β `BT383838`Fdddgoogle`f`b flavor β `BT383838`Fdddfd`f`bβ¦ β
ββββββββββββββββββΌββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββΌββββββ€
β Latest release β Add. These links, files and the table above are generated β see obtainium/.
These providers are also available but may update more slowly.
[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
alt="Get it on F-Droid"
width="24%">](https://f-droid.org/packages/com.geeksville.mesh/)
[<img src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png"
alt="Get it on IzzyOnDroid"
width="24%">](https://apt.izzysoft.de/fdroid/index/apk/com.geeksville.mesh)
[<img src="https://github.com/machiav3lli/oandbackupx/blob/034b226cea5c1b30eb4f6a6f313e4dadcbb0ece4/badge_github.png"
alt="Get it on GitHub"
width="24%">](https://github.com/meshtastic/Meshtastic-Android/releases)
[<img src="https://play.google.com/intl/enus/badges/static/images/badges/enbadgewebgeneric.png"
alt="Get it on Google Play"
width="24%">](https://play.google.com/store/apps/details?id=com.geeksville.mesh&referrer=utm_source%3Dgithub-android-readme)
The play store is the last to update of these options. To join the Play Store testing program, opt in to become a tester.
If you encounter any problems or have questions, ask us on the discord, create an issue, or post in the forum and we'll help as we can.
Desktop
Meshtastic Desktop installers (macOS DMG, Windows MSI/EXE, Linux DEB/RPM/AppImage) are available from GitHub Releases. A Flatpak is available on Flathub (packaging repo: flathub/org.meshtastic.MeshtasticDesktop).
Documentation
The two documentation sites below are deployed to GitHub Pages automatically on every push to T383838main.
βββββββββββββββββββββββββ¬βββββββββββ¬ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β Site β URL β Contents β
βββββββββββββββββββββββββΌβββββββββββΌββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ€
Module Documentation
Each module has its own README with details on its responsibilities, API surface, and internal design.
ββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β Module β Description β
ββββββββββββββΌββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ€
β android.
Integration
The app includes a built-in Local TAK Server feature that can be enabled in settings. This runs a loopback-only TLS (mTLS) server on port 8089 so ATAK on the same device can connect directly and route its traffic over the mesh.
Building the Android App
β [!WARNING] Debug and release builds install side by side to ease development, but don't run both
β at once β force-quit the one you are not using.
Follow the Android development guide to set up your environment.
Note: when building the T383838google flavor locally you will need a Google Maps Android SDK api key to use Google Maps. Create T383838secrets.properties at the repo root and set T383838MAPS_API_KEY=β¦. Without it the build still succeeds with a placeholder key, but map tiles will not load.
e.g.
T282828
T8b949e# secrets.properties
Te6edf3MAPS_API_KEYTff7b72=Ta5d6ffyour_google_maps_api_key_here
Contributing guidelines
For detailed instructions on how to contribute, please see our CONTRIBUTING.md file.
For details on our release process, see the RELEASE_PROCESS.md file.
Repository Statistics
Served by rngit 1.5.2 - Generated in 0.17s